当复仇者联盟遇上Dagger2，rxjava和Retrofit(翻译)

文章目录

1. 1. 依赖注入&Dagger2
2. 2. Dagger2
3. 3. Components，modules&Avengers
4. 4. 结合所有

原文：When the Avengers meet Dagger2, RxJava and Retrofit in a clean way

最近，很多文章，框架和android社区的讨论都谈到了测试和软件架构，就像上一次所提到的，我们关注如何让程序更健壮而不是如何开发更多特性功能。这表示android框架和现在的android社区正在走向成熟。

今天，如果你是一个android开发者但还不知道这几个词：Dagger2,Rxjava和Retrofit，你就要错过一些东西了。本系列会关注如何把这些框架结合起来使用从而实现更清晰的架构。

我本来想只写一篇文章的，但是看到这些框架有这么多的内容，我决定写一个系列，至少三篇文章。

惯例，所有的代码都放到了GitHub上，欢迎建议和拍砖，抱歉我可能没有太多时间去回复所有问题。

avengers

依赖注入&Dagger2

理解这个框架的工作方式会花一些时间，所以我会尽量说清楚。

Dagger2建立在依赖注入模式的基础上。

看下面的代码段：

// Thor is awesome. He has a hammer!
    public class Thor extends Avenger {
        private final AvengerWeapon myAmazingHammer;

        public Thor (AvengerWeapon anAmazingHammer) {
            myAmazingHammer = anAmazingHammer;
        }

        public void doAmazingThorWork () {
            myAmazingHammer.hitSomeone();
        }
    }

索尔需要一个AvengerWeapon去打架，依赖注入的基本思想是与其索尔自己造一个AvengerWeapon，不如通过他的构造方法传给他。如果索尔自己造一个锤子就会增加耦合。

AvengerWeapon可以是一个接口，会根据我们的逻辑以多种方式实现和注入。

在android中，因为框架设计的缘故，要进入类的构造方法并不总是这么容易，比如Activity和Fragment。

这就是依赖注入器发挥好处的时候了，比如Dagger和Guice。

使用Dagger2我们可以把上面的代码转换成这样：

// Thor is awesome. He has a hammer!
    public class Thor extends Avenger {
        @Inject AvengerWeapon myAmazingHammer;

        public void doAmazingThorWork () {
            myAmazingHammer.hitSomeone();
        }
    }

我们没有直接进入索尔的构造方法，注入器，用少量的代码负责构造索尔的锤子

public class ThorHammer extends AvengerWeapon () {

        @Inject public AvengerWeapon() {

            initGodHammer();
        }
    }

@Inject注解告诉Dagger2应该用哪一个构造方法去构造索尔的锤子。

Dagger2

Dagger2是谷歌实现的，是Square开发的Dagger的分支。
首先必须配置注解的处理器，即android-apt插件。
build.gradle(在project的根目录)

dependencies {
        ...
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4'
    }

build.gradle(在你的android module)

apply plugin: 'com.neenbedankt.android-apt'    dependencies {        ...        apt 'com.google.dagger:dagger-compiler:2.0'    }

    dependencies {
        ...
        apt 'com.google.dagger:dagger-compiler:2.0'
    }

Components，modules&Avengers

modules就是提供依赖的，components就是注入这些依赖的。
例子：

@Module
public class AppModule {
    private final AvengersApplication mAvengersApplication;

    public AppModule(AvengersApplication avengersApplication) {
        this.mAvengersApplication = avengersApplication;
    }

    @Provides @Singleton 
    AvengersApplication provideAvengersAppContext () { 
        return mAvengersApplication; 
    }

    @Provides @Singleton 
    Repository provideDataRepository (RestRepository restRepository) { 
        return restRepository; 
    }
}

这是main module，我们感兴趣的是它提供的context，存在于应用的整个生命周期，和一个repository,用来获取信息。
很简单，对吧？
通过@Provides注解，我们告诉Dagger2怎么去构造所需的依赖。否则，对于一个特定的依赖，如果我们不指明一个provider，那么Dagger2会去寻找被@Inject标注的构造方法。
components使用modules去注入依赖，看这个module的component:

@Singleton @Component(modules = AppModule.class)
public interface AppComponent {

    AvengersApplication app();
    Repository dataRepository();
}

这个module并不会被任何activity和fragment调用，而是被一个更复杂的module使用，来提供所需的依赖。
这是依赖树状图:
tree

@Module
public class AvengersModule {

    @Provides @Activity
    List<Character> provideAvengers() {

        List<Character> avengers = new ArrayList<>(6);

        avengers.add(new Character(
            "Iron Man", R.drawable.thumb_iron_man, 1009368));

        avengers.add(new Character(
            "Thor", R.drawable.thumb_thor, 1009664));

        avengers.add(new Character(
            "Captain America", R.drawable.thumb_cap,1009220));

        avengers.add(new Character(
            "Black Widow", R.drawable.thumb_nat, 1009189));

        avengers.add(new Character(
            "Hawkeye", R.drawable.thumb_hawkeye, 1009338));

        avengers.add(new Character(
            "Hulk", R.drawable.thumb_hulk, 1009351));

        return avengers;
    }
}

这个module用来向一个特定的activity注入依赖，实际就是那个负责绘制复仇者联盟列表的activity.

@Activity 
@Component(
    dependencies = AppComponent.class, 
    modules = {
        AvengersModule.class, 
        ActivityModule.class
    }
)
public interface AvengersComponent extends ActivityComponent {

    void inject (AvengersListActivity activity);
    List<Character> avengers();
}

这儿有一个新方法：void inject (AvengersListActivity activity)，这个方法在AvengerListActivity被调用了之后，依赖就可以被消费了。

结合所有

我们的AvengersApplication类，负责向其他component提供appcomponent，注意，它并不注入任何依赖，只是提供component.
AvengersApplication.java

public class AvengersApplication extends Application {

    private AppComponent mAppComponent;

    @Override
    public void onCreate() {

        super.onCreate();
        initializeInjector();
    }

    private void initializeInjector() {

        mAppComponent = DaggerAppComponent.builder()
            .appModule(new AppModule(this))
            .build();
    }

    public AppComponent getAppComponent() {

        return mAppComponent;
    }
}

AvengersListActivity.java

public class AvengersListActivity extends Activity     implements AvengersView {
    implements AvengersView 

    @InjectView(R.id.activity_avengers_recycler) 
    RecyclerView mAvengersRecycler;

    @InjectView(R.id.activity_avengers_toolbar) 
    Toolbar mAvengersToolbar;

    @Inject 
    AvengersListPresenter mAvengersListPresenter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_avengers_list);
        ButterKnife.inject(this);

        initializeToolbar();
        initializeRecyclerView();
        initializeDependencyInjector();
        initializePresenter();
    }

    private void initializeDependencyInjector() {

        AvengersApplication avengersApplication = 
            (AvengersApplication) getApplication();

        DaggerAvengersComponent.builder()
            .avengersModule(new AvengersModule())
            .activityModule(new ActivityModule(this))
            .appComponent(avengersApplication.getAppComponent())
            .build().inject(this);
    }

presenter被初始化，使用了Dagger2提供的avengers

public class AvengersListPresenter implements Presenter, RecyclerClickListener {

    private final List<Character> mAvengersList;
    private final Context mContext;
    private AvengersView mAvengersView;
    private Intent mIntent;

    @Inject public AvengersListPresenter (List<Character> avengers, Context context) {

        mAvengersList = avengers;
        mContext = context;
    }

presenter的构造方法有一个@Inject注解，所以Dagger2会自动解决需要传的参数。
Dagger2知道怎么构造这些参数，因为在module里有@Provides方法。